FHIR IG analytics| Package | hl7.fhir.uv.omop |
| Resource Type | StructureDefinition |
| Id | StructureDefinition-Person.json |
| FHIR Version | R5 |
| Source | https://build.fhir.org/ig/HL7/fhir-omop-ig/StructureDefinition-Person.html |
| URL | http://hl7.org/fhir/uv/omop/StructureDefinition/Person |
| Version | 1.0.0 |
| Status | active |
| Date | 2026-04-02T22:51:15+00:00 |
| Name | Person |
| Title | Person OMOP Table |
| Realm | uv |
| Authority | hl7 |
| Description | This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information. |
| Type | http://hl7.org/fhir/uv/omop/StructureDefinition/Person |
| Kind | logical |
No resources found
No resources found
Note: links and images are rebased to the (stated) source
Generated Narrative: StructureDefinition Person
Language: en
| Name | Flags | Card. | Type | Description & Constraints |
|---|---|---|---|---|
  Person | 0..* | Base | Person OMOP Table Instances of this logical model can be the target of a Reference | |
  person_id | 1..1 | integer | Person Identifier | |
| gender_concept_id | 1..1 | code | Gender | |
| year_of_birth | 1..1 | integer | Year of Birth | |
| month_of_birth | 0..1 | integer | Month of Birth | |
| day_of_birth | 0..1 | integer | Day of Birth | |
| birth_datetime | 0..1 | dateTime | Birth Datetime | |
| race_concept_id | 1..1 | code | Race | |
| ethnicity_concept_id | 1..1 | code | Ethnicity | |
| location_id | 0..1 | integer | Location | |
| provider_id | 0..1 | integer | Provider | |
| care_site_id | 0..1 | integer | Care Site | |
| person_source_value | 0..1 | string | Person Identifier Source Value | |
| gender_source_value | 0..1 | string | Gender Source Value | |
| gender_source_concept_id | 0..1 | code | Gender Source Concept | |
| race_source_value | 0..1 | string | Race Source Value | |
| race_source_concept_id | 0..1 | code | Race Source Concept | |
| ethnicity_source_value | 0..1 | string | Ethnicity Source Value | |
 ethnicity_source_concept_id | 0..1 | code | Ethnicity Source Concept | |
| Documentation for this format | ||||
FHIR
FHIRsmith{
"resourceType": "StructureDefinition",
"id": "Person",
"language": "en",
"text": {
"status": "extensions",
"div": "<!-- snip (see above) -->"
},
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-type-characteristics",
"valueCode": "can-be-target"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode": "brr"
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger": 1,
"_valueInteger": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
},
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode": "informative",
"_valueCode": {
"extension": [
{
"url": "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical": "http://hl7.org/fhir/uv/omop/ImplementationGuide/hl7.fhir.uv.omop"
}
]
}
}
],
"url": "http://hl7.org/fhir/uv/omop/StructureDefinition/Person",
"version": "1.0.0",
"name": "Person",
"title": "Person OMOP Table",
"status": "active",
"date": "2026-04-02T22:51:15+00:00",
"publisher": "HL7 International / Biomedical Research and Regulation",
"contact": [
{
"name": "HL7 International / Biomedical Research and Regulation",
"telecom": [
{
"system": "url",
"value": "http://www.hl7.org/Special/committees/rcrim"
}
]
}
],
"description": "This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.",
"jurisdiction": [
{
"coding": [
{
"system": "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code": "001",
"display": "World"
}
]
}
],
"fhirVersion": "5.0.0",
"mapping": [
{
"identity": "rim",
"uri": "http://hl7.org/v3",
"name": "RIM Mapping"
}
],
"kind": "logical",
"abstract": false,
"type": "http://hl7.org/fhir/uv/omop/StructureDefinition/Person",
"baseDefinition": "http://hl7.org/fhir/StructureDefinition/Base",
"derivation": "specialization",
"snapshot": {
"extension": [
{
"url": "http://hl7.org/fhir/tools/StructureDefinition/snapshot-base-version",
"valueString": "5.0.0"
}
],
"element": [
{
"id": "Person",
"path": "Person",
"short": "Person OMOP Table",
"definition": "This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information.",
"min": 0,
"max": "*",
"base": {
"path": "Base",
"min": 0,
"max": "*"
},
"isModifier": false,
"mapping": [
{
"identity": "rim",
"map": "n/a"
}
]
},
{
"id": "Person.person-id",
"path": "Person.person_id",
"short": "Person Identifier",
"definition": "It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.",
"min": 1,
"max": "1",
"base": {
"path": "Person.person_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.gender-concept-id",
"path": "Person.gender_concept_id",
"short": "Gender",
"definition": "This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.",
"min": 1,
"max": "1",
"base": {
"path": "Person.gender_concept_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.year-of-birth",
"path": "Person.year_of_birth",
"short": "Year of Birth",
"definition": "Compute age using year_of_birth.",
"min": 1,
"max": "1",
"base": {
"path": "Person.year_of_birth",
"min": 1,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.month-of-birth",
"path": "Person.month_of_birth",
"short": "Month of Birth",
"definition": "Month of Birth",
"min": 0,
"max": "1",
"base": {
"path": "Person.month_of_birth",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.day-of-birth",
"path": "Person.day_of_birth",
"short": "Day of Birth",
"definition": "Day of Birth",
"min": 0,
"max": "1",
"base": {
"path": "Person.day_of_birth",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.birth-datetime",
"path": "Person.birth_datetime",
"short": "Birth Datetime",
"definition": "Birth Datetime",
"min": 0,
"max": "1",
"base": {
"path": "Person.birth_datetime",
"min": 0,
"max": "1"
},
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Person.race-concept-id",
"path": "Person.race_concept_id",
"short": "Race",
"definition": "This field captures race or ethnic background of the person.",
"min": 1,
"max": "1",
"base": {
"path": "Person.race_concept_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.ethnicity-concept-id",
"path": "Person.ethnicity_concept_id",
"short": "Ethnicity",
"definition": "This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between “Hispanic” and “Not Hispanic”. Races and ethnic backgrounds are not stored here.",
"min": 1,
"max": "1",
"base": {
"path": "Person.ethnicity_concept_id",
"min": 1,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.location-id",
"path": "Person.location_id",
"short": "Location",
"definition": "The location refers to the physical address of the person. This field should capture the last known location of the person.",
"min": 0,
"max": "1",
"base": {
"path": "Person.location_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.provider-id",
"path": "Person.provider_id",
"short": "Provider",
"definition": "The Provider refers to the last known primary care provider (General Practitioner).",
"min": 0,
"max": "1",
"base": {
"path": "Person.provider_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.care-site-id",
"path": "Person.care_site_id",
"short": "Care Site",
"definition": "The Care Site refers to where the Provider typically provides the primary care.",
"min": 0,
"max": "1",
"base": {
"path": "Person.care_site_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.person-source-value",
"path": "Person.person_source_value",
"short": "Person Identifier Source Value",
"definition": "Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.",
"min": 0,
"max": "1",
"base": {
"path": "Person.person_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.gender-source-value",
"path": "Person.gender_source_value",
"short": "Gender Source Value",
"definition": "This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"base": {
"path": "Person.gender_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.gender-source-concept-id",
"path": "Person.gender_source_concept_id",
"short": "Gender Source Concept",
"definition": "If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.",
"min": 0,
"max": "1",
"base": {
"path": "Person.gender_source_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.race-source-value",
"path": "Person.race_source_value",
"short": "Race Source Value",
"definition": "This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"base": {
"path": "Person.race_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.race-source-concept-id",
"path": "Person.race_source_concept_id",
"short": "Race Source Concept",
"definition": "If the source data codes race in an OMOP supported vocabulary store the concept_id here.",
"min": 0,
"max": "1",
"base": {
"path": "Person.race_source_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.ethnicity-source-value",
"path": "Person.ethnicity_source_value",
"short": "Ethnicity Source Value",
"definition": "This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"base": {
"path": "Person.ethnicity_source_value",
"min": 0,
"max": "1"
},
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.ethnicity-source-concept-id",
"path": "Person.ethnicity_source_concept_id",
"short": "Ethnicity Source Concept",
"definition": "If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.",
"min": 0,
"max": "1",
"base": {
"path": "Person.ethnicity_source_concept_id",
"min": 0,
"max": "1"
},
"type": [
{
"code": "code"
}
]
}
]
},
"differential": {
"element": [
{
"id": "Person",
"path": "Person",
"short": "Person OMOP Table",
"definition": "This table serves as the central identity management for all Persons in the database. It contains records that uniquely identify each person or patient, and some demographic information."
},
{
"id": "Person.person-id",
"path": "Person.person_id",
"short": "Person Identifier",
"definition": "It is assumed that every person with a different unique identifier is in fact a different person and should be treated independently.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.gender-concept-id",
"path": "Person.gender_concept_id",
"short": "Gender",
"definition": "This field is meant to capture the biological sex at birth of the Person. This field should not be used to study gender identity issues.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.year-of-birth",
"path": "Person.year_of_birth",
"short": "Year of Birth",
"definition": "Compute age using year_of_birth.",
"min": 1,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.month-of-birth",
"path": "Person.month_of_birth",
"short": "Month of Birth",
"definition": "Month of Birth",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.day-of-birth",
"path": "Person.day_of_birth",
"short": "Day of Birth",
"definition": "Day of Birth",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.birth-datetime",
"path": "Person.birth_datetime",
"short": "Birth Datetime",
"definition": "Birth Datetime",
"min": 0,
"max": "1",
"type": [
{
"code": "dateTime"
}
]
},
{
"id": "Person.race-concept-id",
"path": "Person.race_concept_id",
"short": "Race",
"definition": "This field captures race or ethnic background of the person.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.ethnicity-concept-id",
"path": "Person.ethnicity_concept_id",
"short": "Ethnicity",
"definition": "This field captures Ethnicity as defined by the Office of Management and Budget (OMB) of the US Government: it distinguishes only between “Hispanic” and “Not Hispanic”. Races and ethnic backgrounds are not stored here.",
"min": 1,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.location-id",
"path": "Person.location_id",
"short": "Location",
"definition": "The location refers to the physical address of the person. This field should capture the last known location of the person.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.provider-id",
"path": "Person.provider_id",
"short": "Provider",
"definition": "The Provider refers to the last known primary care provider (General Practitioner).",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.care-site-id",
"path": "Person.care_site_id",
"short": "Care Site",
"definition": "The Care Site refers to where the Provider typically provides the primary care.",
"min": 0,
"max": "1",
"type": [
{
"code": "integer"
}
]
},
{
"id": "Person.person-source-value",
"path": "Person.person_source_value",
"short": "Person Identifier Source Value",
"definition": "Use this field to link back to persons in the source data. This is typically used for error checking of ETL logic.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.gender-source-value",
"path": "Person.gender_source_value",
"short": "Gender Source Value",
"definition": "This field is used to store the biological sex of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.gender-source-concept-id",
"path": "Person.gender_source_concept_id",
"short": "Gender Source Concept",
"definition": "If the source data codes biological sex in a non-standard vocabulary, store the concept_id here.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.race-source-value",
"path": "Person.race_source_value",
"short": "Race Source Value",
"definition": "This field is used to store the race of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.race-source-concept-id",
"path": "Person.race_source_concept_id",
"short": "Race Source Concept",
"definition": "If the source data codes race in an OMOP supported vocabulary store the concept_id here.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
},
{
"id": "Person.ethnicity-source-value",
"path": "Person.ethnicity_source_value",
"short": "Ethnicity Source Value",
"definition": "This field is used to store the ethnicity of the person from the source data. It is not intended for use in standard analytics but for reference only.",
"min": 0,
"max": "1",
"type": [
{
"code": "string"
}
]
},
{
"id": "Person.ethnicity-source-concept-id",
"path": "Person.ethnicity_source_concept_id",
"short": "Ethnicity Source Concept",
"definition": "If the source data codes ethnicity in an OMOP supported vocabulary, store the concept_id here.",
"min": 0,
"max": "1",
"type": [
{
"code": "code"
}
]
}
]
}
}